home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 081 / omam_112.arc / NEW_112.DOC < prev    next >
Text File  |  1987-12-18  |  12KB  |  298 lines
  1.  
  2.  
  3.         This  file  summarizes  changes from version 1.01  of  RASMAM  to
  4.         version 1.12:
  5.  
  6.         ----
  7.         The  program will no longer crash when your user list  is  large.
  8.         Version  1.10  and earlier tried to load as many  user  names  as
  9.         possible  into  memory then used a hash table to look up  a  name
  10.         when  necessary.   If  the  name wasn't  in  memory,  RASMAM  was
  11.         supposed  to  look in the user file.  But it didn't  do  it  very
  12.         well.
  13.  
  14.         Version  1.12 does not load any names into memory.   Instead,  it
  15.         builds  a  hash  table  using a  30-bit  hash.   This  definitely
  16.         improves  the  execution speed and makes RASMAM work  with  large
  17.         user files.   Conflicts (which  should be rare)  are resolved  by
  18.         looking in the user file.
  19.  
  20.         The maximum number of users that RASMAM can handle is 2000.    If
  21.         you have more  than 2000  names in  your  user list,  RASMAM will
  22.         display an error message and exit.
  23.  
  24.         -----
  25.         The hash used to store the subject of each message is now 16-bits
  26.         long.   This should reduce the chances of two different  subjects
  27.         being linked by the RENUM CHAIN or RENUM SUBJECT commands.
  28.  
  29.         -----
  30.         After a RENUM CHAIN or RENUM SUBJECT, the last message in an area
  31.         should no longer display a message saying "There is a reply."
  32.  
  33.         -----
  34.         RASMAM now uses the Opus binary date stamps in each message.
  35.  
  36.         -----
  37.         The names of the built-in macros have changed (since 1.01)
  38.  
  39.              var.     formerly        becomes
  40.  
  41.           #JULIAN#      #J#    -- the current day of the year (001..366)
  42.           #DAY#         #D#    -- the current day of the month (01..31)
  43.           #MONTH#       #M#    -- the current month (01..12)
  44.           #YEAR#        #Y#    -- the current year (87..99)
  45.  
  46.           $WEEKDAY$     $D$    -- the current weekday (SUN..SAT)
  47.           $MONTH$       $M$    -- the current month (JAN..DEC)
  48.  
  49.           $SCRIPT$      $C$    -- name of the current MAM configuration file
  50.  
  51.           %var%                -- value of specified environment variable
  52.  
  53.           %%                   -- %
  54.           ##                   -- #
  55.           $$                   -- $
  56.  
  57.       New built-in macros:
  58.  
  59.           #HOUR#              -- hour when MAM was run (00..23)
  60.           #MINUTE#            -- minute when MAM was run (00..59)
  61.           #AREA#              -- number of current message area (00..99)
  62.           #user name#         -- user number of specified user (0..???)
  63.  
  64.           $PATH$             -- path to current message area
  65.           $net/node$         -- Hex string NNNNnnn where NNNN is net and
  66.                              -- nnnn is node. For example,
  67.                              -- $366/14$ becomes 016E000E
  68.  
  69.       LOCK
  70.       UNLOCK
  71.         Stop/Start Check Messages Waiting for User
  72.  
  73.                                 LOCK {user|priv}
  74.                                UNLOCK {user|priv}
  75.  
  76.         The  LOCK command tells MAM to stop listing messages waiting  for
  77.         the  specified  user (or group of users by  privilege)  until  an
  78.         UNLOCK  command is issued for the user (or users).  For  example,
  79.         suppose you have a regular caller, James Young, that is the Sysop
  80.         of  another  BBS. His board participates in the  MEADOW  echomail
  81.         conference so you don't want MAM to list messages for him waiting
  82.         in the MEADOW area. You can use the following LOCK command before
  83.         checking MEADOW:
  84.  
  85.                                 LOCK James Young
  86.  
  87.         If you don't want MAM to list messages waiting for TWITS, use:
  88.  
  89.                                   LOCK Twits
  90.  
  91.         The  UNLOCK  command  reverses the effect of  the  LOCK  command.
  92.         Following  up  on the example earlier, you  should  UNLOCK  James
  93.         Young  after scanning MEADOW so he will be notified  of  messages
  94.         waiting in other areas:
  95.  
  96.                                UNLOCK James Young
  97.  
  98.       KILL
  99.         Delete messages based on number of messages or age of messages
  100.  
  101.          KILL [PRIVATE] [RECEIVED] [WHEN i] [DAYS j] [SKIP k] [KEEP l]
  102.  
  103.         The  SKIP option has been added.  The SKIP option specifies  that
  104.         the KILL command should not delete any of the first k messages in
  105.         the  area.
  106.  
  107.           Kill all messages over 90 days old except the first 5 messages:
  108.             KILL DAYS 90 SKIP 5
  109.  
  110.       ARCHIVE
  111.         Move messages to a text file
  112.  
  113.           ARCHIVE [PRIVATE] [RECEIVED] [DAYS i] [SKIP j] [KEEP k] [PRIVATE] TO file
  114.  
  115.         The  SKIP  option has been added.  It functions as  in  the  KILL
  116.         command.
  117.  
  118.       INCLUDE
  119.         Include a script file
  120.  
  121.                                INCLUDE script-file
  122.  
  123.         The INCLUDE command causes RASMAM to begin reading the  specified
  124.         script  file.   When the end of that script  is  reached,  RASMAM
  125.         resumes reading the current script file.  Just a word of warning,
  126.         the INCLUDE command is slow.
  127.  
  128.           INCLUDE c:\opus\include.mam
  129.  
  130.         The  name  of the script file should be fully  qualified  with  a
  131.         drive, path. and extension specified.  INCLUDEs may be nested  up
  132.         to 10 levels.
  133.  
  134.       IF
  135.       END IF
  136.         Conditionally execute commands
  137.  
  138.                            IF [@NOT] expression [THEN]
  139.                                 ... commands ...
  140.                            END IF
  141.  
  142.         The  IF  and END IF commands allow you to  conditionally  execute
  143.         portions of your script file.
  144.  
  145.         The conditional expression is:
  146.  
  147.           value1 == value2  (or =)  true if value1 equals value2
  148.           value1 != value2  (or <>) true if value1 doesn't equal value2
  149.           value1 < value2           true if value1 less than value2
  150.           value1 > value2           true if value1 greater than value2
  151.           value1 <= value2          true if value1 less than or equal to value2
  152.           value1 >= value2          true if value1 greater than or equal to value2
  153.           value1 IN value2          true if value1 is contained in value2
  154.           @EXISTS filespec          true if filespec exists
  155.  
  156.         Values  are all one word (no spaces). @NOT inverts the result  of
  157.         the  condition.   You MUST put a space before and one  after  the
  158.         operator.
  159.  
  160.         Here are some examples of IF/END IF commands:
  161.  
  162.           IF $MONTH$ == JAN THEN
  163.             LOG It is January.
  164.           END IF
  165.  
  166.           LOG IF/END IFs may be nested up to 32767 levels
  167.           IF @EXISTS c:\opus\system99.bbs THEN
  168.             IF $WEEKDAY$ IN TUETHU THEN
  169.               LOG It is Tuesday or Thursday ($WEEKDAY$) and SYSTEM99.BBS exists
  170.             END IF
  171.             IF $MONTH$ <> JAN THEN
  172.               LOG System99.BBS exists, but the month is not January
  173.             END IF
  174.           END IF
  175.  
  176.       ERASE
  177.         Deletes the specified file or files.
  178.  
  179.                                  ERASE filespec
  180.  
  181.         The  ERASE  command deletes the files that  match  the  specified
  182.         filespec. Wildcards may be used. For example,
  183.  
  184.           Delete BULLETIN.BBS and BULLETIN.GBS in C:\OPUS\MISC:
  185.             ERASE c:\opus\misc\bulletin.?bs
  186.  
  187.           Delete the custom welcome waiting for the user named "SYSOP":
  188.             ERASE c:\opus\#sysop#.BBS
  189.  
  190.       ADD
  191.         Concatenate files
  192.  
  193.                     ADD filespec TO filespec GIVING filespec
  194.  
  195.         The ADD command concatenates (adds) two files and puts the result
  196.         in  a  third file. The output file is overwritten if  it  exists.
  197.         The  output file may be the same file as one of the  files  being
  198.         concatenated.
  199.  
  200.           Add a file to the front of BULLETIN.BBS:
  201.             ADD $misc$\bull1.bbs TO $misc$\bulletin.bbs GIVING $misc$\bulletin.bbs
  202.  
  203.       SHELL
  204.         Execute a DOS command
  205.  
  206.                                SHELL command-line
  207.  
  208.         The  SHELL  command  executes a DOS command.  The  SHELL  command
  209.         requires DOS 3.1 or higher.
  210.  
  211.           Display a directory:
  212.             SHELL dir $misc$
  213.  
  214.       ARC
  215.       PKARC
  216.  
  217.                                        ARC
  218.                                        or
  219.                                       PKARC
  220.  
  221.         The  ARC  and  PKARC commands select  the  archive  utility  that
  222.         RASMAM's  Picture Gallery commands will use to read the  list  of
  223.         picture files and to extract pictures.
  224.  
  225.         ARC tells RASMAM to use SEA's arc utility (PKARC selects PKWARE's
  226.         program).  Your copy of ARC (or PKARC and PKXARC) must be in  the
  227.         current path.
  228.  
  229.       PATH TEMP
  230.         Declare a directory for temporary files
  231.  
  232.                                PATH TEMP directory
  233.  
  234.         The PATH TEMP command tells RASMAM the path to a directory  where
  235.         it should create its temporary files. RASMAM uses this  directory
  236.         to  store  the  picture file that it extracts  from  an  archive.
  237.         After  it finishes, RASMAM deletes the file from  the  directory.
  238.         Therefore,  to  avoid the possibility of  RASMAM  overwriting  an
  239.         existing  file,  create a temporary directory just  for  RASMAM's
  240.         use.
  241.  
  242.       PICTURE FILE
  243.         Declare a picture archive file
  244.  
  245.                               PICTURE FILE filespec
  246.  
  247.         PICTURE  FILE  tells  RASMAM the name of  an  archive  containing
  248.         pictures.  RASMAM will read the names of the picture  files  from
  249.         the archive.
  250.  
  251.       PICTURE HEADER
  252.       PICTURE TRAILER
  253.       PICTURE INDEX
  254.  
  255.                              PICTURE HEADER filespec
  256.                              PICTURE TRAILER filespec
  257.                              PICTURE INDEX filespec
  258.  
  259.         PICTURE HEADER supplies the name of a file that will be  prefixed
  260.         to any picture file that RASMAM creates.
  261.  
  262.         PICTURE TRAILER supplies the name of a file that will be appended
  263.         to any picture file that RASMAM creates.
  264.  
  265.         PICTURE  INDEX  supplies the name of a file that RASMAM  uses  to
  266.         keep track of the last picture it displayed.
  267.  
  268.       PICTURE NEXT
  269.       PICTURE RANDOM
  270.  
  271.                         PICTURE {NEXT|RANDOM} TO filespec
  272.  
  273.         PICTURE  NEXT  chooses the next picture in  the  current  picture
  274.         archive and sends it to the specified file (adding the header and
  275.         trailer if any).
  276.  
  277.         PICTURE  RANDOM  chooses  a picture at random  from  the  current
  278.         picture archive file and sends it to the specified file.
  279.  
  280.       DATE
  281.         Select Date Type
  282.  
  283.                             DATE {ARRIVED | WRITTEN}
  284.  
  285.         The  DATE command allows you to select how RASMAM will  determine
  286.         the age of a message.  DATE ARRIVED tells RASMAM to use the  date
  287.         the message arrived on your system.  DATE WRITTEN tells RASMAM to
  288.         use the date the message was created.
  289.  
  290.       MESSAGES
  291.  
  292.         The MESSAGES command is no longer needed and if used will produce
  293.         a  warning.  RASMAM will only handle messages numbered 1  through
  294.         2000.   If you have any messages which are numbered greater  than
  295.         2000  then  you'll need to purge the message area to  reduce  the
  296.         number of messages to less than 2000 then renumber using  another
  297.         renumbering utility such as RENUM.
  298.